<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python documentation Index' />
<link rel="first" href="lib.html" title='Python library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="prev" href="module-md5.html" />
<link rel="parent" href="crypto.html" />
<link rel="next" href="filesys.html" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name='aesop' content='information' />
<title>10.4 sha -- SHA-1 message digest algorithm</title>
</head>
<body>
<div class="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="10.3 md5  "
  href="module-md5.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="10. cryptographic Services"
  href="crypto.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="11. file and Directory"
  href="filesys.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-md5.html">10.3 md5  </a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="crypto.html">10. Cryptographic Services</a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="filesys.html">11. File and Directory</a>
</div>
<hr /></div>
</div>
<!--End of Navigation Panel-->

<h1><a name="SECTION0012400000000000000000">
10.4 <tt class="module">sha</tt> --
         SHA-1 message digest algorithm</a>
</h1>

<p>
<a name="module-sha"></a>

<p>
<div class="versionnote"><b>Deprecated since release 2.5.</b>
Use the <tt class="module"><a href="module-hashlib.html">hashlib</a></tt> module instead.</div><p></p>

<p>
This module implements the interface to NIST's<a id='l2h-2163' xml:id='l2h-2163'></a> secure hash 
algorithm,<a id='l2h-2164' xml:id='l2h-2164'></a> known as SHA-1.  SHA-1 is an
improved version of the original SHA hash algorithm.  It is used in
the same way as the <tt class="module"><a href="module-md5.html">md5</a></tt> module: use <tt class="function">new()</tt>
to create an sha object, then feed this object with arbitrary strings
using the <tt class="method">update()</tt> method, and at any point you can ask it
for the <i class="dfn">digest</i> of the concatenation of the strings fed to it
so far.<a id='l2h-2165' xml:id='l2h-2165'></a>  SHA-1 digests are 160 bits instead of
MD5's 128 bits.

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2156' xml:id='l2h-2156' class="function">new</tt></b>(</nobr></td>
  <td><var></var><big>[</big><var>string</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
  Return a new sha object.  If <var>string</var> is present, the method
  call <code>update(<var>string</var>)</code> is made.
</dl>

<p>
The following values are provided as constants in the module and as
attributes of the sha objects returned by <tt class="function">new()</tt>:

<p>
<dl><dt><b><tt id='l2h-2157' xml:id='l2h-2157'>blocksize</tt></b></dt>
<dd>
  Size of the blocks fed into the hash function; this is always
  <code>1</code>.  This size is used to allow an arbitrary string to be
  hashed.
</dd></dl>

<p>
<dl><dt><b><tt id='l2h-2158' xml:id='l2h-2158'>digest_size</tt></b></dt>
<dd>
  The size of the resulting digest in bytes.  This is always
  <code>20</code>.
</dd></dl>

<p>
An sha object has the same methods as md5 objects:

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2159' xml:id='l2h-2159' class="method">update</tt></b>(</nobr></td>
  <td><var>arg</var>)</td></tr></table></dt>
<dd>
Update the sha object with the string <var>arg</var>.  Repeated calls are
equivalent to a single call with the concatenation of all the
arguments: <code>m.update(a); m.update(b)</code> is equivalent to
<code>m.update(a+b)</code>.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2160' xml:id='l2h-2160' class="method">digest</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Return the digest of the strings passed to the <tt class="method">update()</tt>
method so far.  This is a 20-byte string which may contain
non-ASCII characters, including null bytes.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2161' xml:id='l2h-2161' class="method">hexdigest</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Like <tt class="method">digest()</tt> except the digest is returned as a string of
length 40, containing only hexadecimal digits.  This may 
be used to exchange the value safely in email or other non-binary
environments.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2162' xml:id='l2h-2162' class="method">copy</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Return a copy (``clone'') of the sha object.  This can be used to
efficiently compute the digests of strings that share a common initial
substring.
</dl>

<p>
<div class="seealso">
  <p class="heading">See Also:</p>

  <dl compact="compact" class="seetitle">
    <dt><em class="citetitle"><a href="http://csrc.nist.gov/publications/fips/fips180-2/fips180-2withchangenotice.pdf"
        >Secure Hash Standard</a></em></dt>
    <dd>The Secure Hash Algorithm is defined by NIST document FIPS
     PUB 180-2:
     <em class="citetitle"><a
 href="http://csrc.nist.gov/publications/fips/fips180-2/fips180-2withchangenotice.pdf"
 title="Secure Hash Standard"
 >Secure Hash Standard</a></em>, published in August 2002.</dd>
  </dl>

<p>
<dl compact="compact" class="seetitle">
    <dt><em class="citetitle"><a href="http://csrc.nist.gov/encryption/tkhash.html"
        >Cryptographic Toolkit (Secure Hashing)</a></em></dt>
    <dd>Links from NIST to various information on secure hashing.</dd>
  </dl>
</div>

<p>

<div class="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="10.3 md5  "
  href="module-md5.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="10. cryptographic Services"
  href="crypto.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="11. file and Directory"
  href="filesys.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-md5.html">10.3 md5  </a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="crypto.html">10. Cryptographic Services</a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="filesys.html">11. File and Directory</a>
</div>
</div>
<hr />
<span class="release-info">Release 2.5.1, documentation updated on 18th April, 2007.</span>
</div>
<!--End of Navigation Panel-->
<address>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</address>
</body>
</html>
